i2crepeater.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef I2CREPEATER_H
#define I2CREPEATER_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"




#define I2CREPEATER_DEVICE_ADDRESS          0x00
 // i2crepeater_set



#define I2CREPEATER_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST );
 // i2crepeater_map // i2crepeater

typedef struct
{
    // Output pins
    digital_out_t en;           
 
    // Modules
    i2c_master_t i2c;           
 
    // I2C slave address
    uint8_t slave_address;      
 
} i2crepeater_t;

typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
 
    pin_name_t en;              
 
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
 
} i2crepeater_cfg_t;

typedef enum
{
    I2CREPEATER_OK = 0,
    I2CREPEATER_ERROR = -1
 
} i2crepeater_return_value_t;


void i2crepeater_cfg_setup ( i2crepeater_cfg_t *cfg );

err_t i2crepeater_init ( i2crepeater_t *ctx, i2crepeater_cfg_t *cfg );

void i2crepeater_enable_device ( i2crepeater_t *ctx );

void i2crepeater_disable_device ( i2crepeater_t *ctx );

err_t i2crepeater_set_i2c_address ( i2crepeater_t *ctx, uint8_t slave_addr );

err_t i2crepeater_i2c_write ( i2crepeater_t *ctx, uint8_t *data_in, uint16_t len );

err_t i2crepeater_i2c_read ( i2crepeater_t *ctx, uint8_t *data_out, uint16_t len );

err_t i2crepeater_i2c_write_then_read ( i2crepeater_t *ctx, uint8_t *data_in, uint16_t in_len, 
                                                            uint8_t *data_out, uint8_t out_len );

err_t i2crepeater_i2c_write_reg ( i2crepeater_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );

err_t i2crepeater_i2c_read_reg ( i2crepeater_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
#ifdef __cplusplus
}
#endif
#endif // I2CREPEATER_H
 // i2crepeater
 
// ------------------------------------------------------------------------ END